Stage a chunk of rows onto a job (≤5k rows/request, job must be `staging`)
curl --request POST \
--url https://api.example.com/v1/imports/{id}/rows \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"rows": [
{
"rowNumber": 123,
"payload": {
"email": "jsmith@example.com",
"external_id": "<string>",
"display_name": "<string>",
"locale": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"country": "<string>",
"dob": "<string>",
"attributes": {},
"labels": [
"<string>"
]
}
}
]
}
'import requests
url = "https://api.example.com/v1/imports/{id}/rows"
payload = { "rows": [
{
"rowNumber": 123,
"payload": {
"email": "jsmith@example.com",
"external_id": "<string>",
"display_name": "<string>",
"locale": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"country": "<string>",
"dob": "<string>",
"attributes": {},
"labels": ["<string>"]
}
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
rows: [
{
rowNumber: 123,
payload: {
email: 'jsmith@example.com',
external_id: '<string>',
display_name: '<string>',
locale: '<string>',
first_name: '<string>',
last_name: '<string>',
country: '<string>',
dob: '<string>',
attributes: {},
labels: ['<string>']
}
}
]
})
};
fetch('https://api.example.com/v1/imports/{id}/rows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/imports/{id}/rows",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'rows' => [
[
'rowNumber' => 123,
'payload' => [
'email' => 'jsmith@example.com',
'external_id' => '<string>',
'display_name' => '<string>',
'locale' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'country' => '<string>',
'dob' => '<string>',
'attributes' => [
],
'labels' => [
'<string>'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/imports/{id}/rows"
payload := strings.NewReader("{\n \"rows\": [\n {\n \"rowNumber\": 123,\n \"payload\": {\n \"email\": \"jsmith@example.com\",\n \"external_id\": \"<string>\",\n \"display_name\": \"<string>\",\n \"locale\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"country\": \"<string>\",\n \"dob\": \"<string>\",\n \"attributes\": {},\n \"labels\": [\n \"<string>\"\n ]\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/imports/{id}/rows")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"rows\": [\n {\n \"rowNumber\": 123,\n \"payload\": {\n \"email\": \"jsmith@example.com\",\n \"external_id\": \"<string>\",\n \"display_name\": \"<string>\",\n \"locale\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"country\": \"<string>\",\n \"dob\": \"<string>\",\n \"attributes\": {},\n \"labels\": [\n \"<string>\"\n ]\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/imports/{id}/rows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"rows\": [\n {\n \"rowNumber\": 123,\n \"payload\": {\n \"email\": \"jsmith@example.com\",\n \"external_id\": \"<string>\",\n \"display_name\": \"<string>\",\n \"locale\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"country\": \"<string>\",\n \"dob\": \"<string>\",\n \"attributes\": {},\n \"labels\": [\n \"<string>\"\n ]\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"staged": 0
}{
"error": {
"code": "<string>",
"status": 123,
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"status": 123,
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"status": 123,
"message": "<string>",
"details": {}
}
}Imports
Stage a chunk of rows onto a job (≤5k rows/request, job must be `staging`)
POST
/
v1
/
imports
/
{id}
/
rows
Stage a chunk of rows onto a job (≤5k rows/request, job must be `staging`)
curl --request POST \
--url https://api.example.com/v1/imports/{id}/rows \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"rows": [
{
"rowNumber": 123,
"payload": {
"email": "jsmith@example.com",
"external_id": "<string>",
"display_name": "<string>",
"locale": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"country": "<string>",
"dob": "<string>",
"attributes": {},
"labels": [
"<string>"
]
}
}
]
}
'import requests
url = "https://api.example.com/v1/imports/{id}/rows"
payload = { "rows": [
{
"rowNumber": 123,
"payload": {
"email": "jsmith@example.com",
"external_id": "<string>",
"display_name": "<string>",
"locale": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"country": "<string>",
"dob": "<string>",
"attributes": {},
"labels": ["<string>"]
}
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
rows: [
{
rowNumber: 123,
payload: {
email: 'jsmith@example.com',
external_id: '<string>',
display_name: '<string>',
locale: '<string>',
first_name: '<string>',
last_name: '<string>',
country: '<string>',
dob: '<string>',
attributes: {},
labels: ['<string>']
}
}
]
})
};
fetch('https://api.example.com/v1/imports/{id}/rows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/imports/{id}/rows",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'rows' => [
[
'rowNumber' => 123,
'payload' => [
'email' => 'jsmith@example.com',
'external_id' => '<string>',
'display_name' => '<string>',
'locale' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'country' => '<string>',
'dob' => '<string>',
'attributes' => [
],
'labels' => [
'<string>'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/imports/{id}/rows"
payload := strings.NewReader("{\n \"rows\": [\n {\n \"rowNumber\": 123,\n \"payload\": {\n \"email\": \"jsmith@example.com\",\n \"external_id\": \"<string>\",\n \"display_name\": \"<string>\",\n \"locale\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"country\": \"<string>\",\n \"dob\": \"<string>\",\n \"attributes\": {},\n \"labels\": [\n \"<string>\"\n ]\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/imports/{id}/rows")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"rows\": [\n {\n \"rowNumber\": 123,\n \"payload\": {\n \"email\": \"jsmith@example.com\",\n \"external_id\": \"<string>\",\n \"display_name\": \"<string>\",\n \"locale\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"country\": \"<string>\",\n \"dob\": \"<string>\",\n \"attributes\": {},\n \"labels\": [\n \"<string>\"\n ]\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/imports/{id}/rows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"rows\": [\n {\n \"rowNumber\": 123,\n \"payload\": {\n \"email\": \"jsmith@example.com\",\n \"external_id\": \"<string>\",\n \"display_name\": \"<string>\",\n \"locale\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"country\": \"<string>\",\n \"dob\": \"<string>\",\n \"attributes\": {},\n \"labels\": [\n \"<string>\"\n ]\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"staged": 0
}{
"error": {
"code": "<string>",
"status": 123,
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"status": 123,
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"status": 123,
"message": "<string>",
"details": {}
}
}Authorizations
Organization API key (org_…), sent as Authorization: Bearer <key>. Keys are scoped to one organization; every request operates within that tenant.
Path Parameters
Body
application/json
Minimum array length:
1Show child attributes
Show child attributes
Response
Rows staged
Required range:
-9007199254740991 <= x <= 9007199254740991Page a job's per-row outcomes, optionally filtered by stateSeal staging and start async dry-run validation
⌘I